.. highlightlang:: us

.. index:: @f{xystatvalue}

.. _@f{xystatvalue}:

@f{xystatvalue}
===============

.. us.tag  @f{xystatvalue} GERMAN fieldfunction

Schreibt eine statistische Kennzahl für den angegebenen 1D oder 2D Datensatz in
das Textobjekt.

.. function::  @f{xystatvalue(DatasetName, Type)}
               @f{xystatvalue(DatasetName, Type, Format)}

.. us.params

**Parameter**

.. uparam:: DatasetName

   Ist der Name eines 1D- oder 2D-Datensatzes. Wenn an den Datensatznamen getrennt
   durch einen Doppelpunkt der Seitenname angehängt wird, kann sich der Datensatz
   auch auf einer anderen Seite im gleichen Dokument befinden. Beispiel: 
   ``Data1:Seite 2``.

.. uparam:: Type

   Ist der Name der statistischen Kennzahl:

   .. list-table::
      :header-rows: 1

      * - Wert
        - Bedeutung
      * - xmin
        - Wert der kleinsten x-Koordinate.
      * - xmax
        - Wert der größten x-Koordinate.
      * - ymin
        - Wert der kleinsten y-Koordinate.
      * - ymax
        - Wert der größten y-Koordinate.
      * - yfirst
        - y-Wert des ersten Datenpunktes.
      * - ylast
        - y-Wert des letzten Datenpunktes.
      * - xmean
        - arithmetischer Mittelwert der x-Koordinate.
      * - ymean
        - arithmetischer Mittelwert der y-Koordinate.
      * - yminpos
        - x-Position der kleinsten y-Koordinate.
      * - ymaxpos
        - x-Position der größten y-Koordinate.
      * - corr
        - Korrelationkoeffizient zwischen den x- und y-Koordinaten.
      * - meandeviation
        - Varianz der y-Koordinaten.
      * - variance
        - Varianz der y-Koordinaten.
      * - standarddeviation
        - Standardabweichung der y-Koordinaten.
      * - r2
        - Bestimmtheitsmaß.
      * - median
        - Median oder Zentralwert. Entspricht dem 0.5-Quantil.
      * - quantile
        - Beim Quantil wird der Wert duch ein Semicolon getrennt angehängt,
          z. B.: quantile:0.1 (das 0.1-Quantil) ist der Wert des Punktes, bei dem
          10% aller Punkte kleiner sind.
      * - name
        - Gibt den Kanalnamen aus. Kann an den Wertnamen getrennt durch einen Punkt (.)
          angehängt werden, z. B. ``@f{xystatvalue(Data6, ymean.name.unit)}`` 
      * - unit
        - Gibt die Einheit aus, z. B. ``@f{xystatvalue(Data6, ymean.unit)}``

   An den Typ-Namen kann noch der Text ``:date`` angehängt werden. Dann 
   wird der Wert als Datum formatiert.

.. uparam:: Format

   Legt das Zahlenformat fest. Defaultformat ist ``%g``. Um z. B. drei
   Nachkommastellen auszugeben, können für den Format-Parameter ``%.3lf``
   angegeben werden. Weitere Informationen über den Format-String finden Sie
   unter :ref:`printf`. Innerhalb des Formatstrings darf bei Feldfunktionen kein
   Komma verwendet werden.

.. us.comment

**Kommentar**

Um den Namen eines Datensatzes herauszufinden, klicken Sie den Datensatz mit der
Maus an. Der Name wird dann in der Statuszeile angezeigt, z. B. ``Data3``.

.. us.example

**Beispiel**

``x-Min: @f{xystatvalue(Data1, xmin)}``

**Ausgabe**:

``x-Min: 12.34``

.. us.example

**Beispiel**

Mean @f{xystatvalue(Data4,ymean.name.unit, %.1lf)}

**Ausgabe**:

``Mean AFS: 301.7 Kg/h``

.. us.example

**Beispiel**

Beispiel für 10% Quantil:

``10% Quantil: @f{xyvalue(Data1, name)} = @f{xystatvalue(Data1, quantile:0.1, %.2lf)} @f{xyvalue(Data1, unit)}``

**Ausgabe**:

``10% Quantil: P = 3.23 bar``

.. seealso::
   :ref:`uberblick-feldfunktionen`,
   :ref:`bearbeitenfelder-aktualisieren`,
   :ref:`diagrammfeldfunktion-einfugen`,
   :ref:`dateialias-tabelle-bearbeiten`

:sub:`id-1172197`